.\" Michael P. Reilly (C) 2014-2015 All rights reserved
.\" server.man $RelNo$  $Revision$
.\" Process this file with
.\" groff -man -Tascii svrfilter.5
.\"
.TH svrfilter 5 "February 2015" GNU/Python "File formats"
.SH NAME
svrfilter \- data file for host management
.SH DESCRIPTION
server.lst conains one line for each entries, with either six or seven fields
delimited by vpipe characters ("|").
Comments start with a "#" and empty lines are ignored.
The fields in version 2 are:
.br
.IR prod | env | host | user | net | active | apptools
.br
or
.br
.IR prod | env | host | user | net | active | bridge | ordinal
.br
.SS Data format - version 2
Data files are essentially vpipe ("|") separated files (CSV),
with either 7 or 8 fields.
.IP prod
The product name, should be unique across products
.IP env
The logic operating environment.
Example, the development vs production environment.
.IP host
The hostname, without domain, or the IP address of the server.  With multiple
products spread across multiple servers, each server should have its own
data entry.
.IP user
The username on the host where the product is installed.
.IP net
The network/data center where the product resides.
If there is only one network/data center, then this field can be ignored.
.IP active
This allows for servers to be removed from service, but still accessible.
The "manual" value is for systems
which may not be programmatically accessible (e.g. windows boxes).
.IP apptools
The server has Apptools installed and usuable.
.PP
An example data file might look like:
.RS
.nf
felofel|test|tfelofel01|tomcat|qa1|yes|yes
felofel|test|tfelofel02|tomcat|qa1|yes|yes
felofel|prod|nycvm01|felfel|nyc|yes|yes
felofel|prod|nycvm02|tomuser|nyc|no|yes
felofel|prod|nycvm03|felfel|nyc|yes|yes
felofel|prod|tanvm01|felfel|la|yes|yes
felofel|prod|tanvm02|felfel|la|yes|yes
.fi
.RE
.PP
Instead of the "apptools" field, two others could be used:
.IP bridge
The bridge name associated with the server.
.IP ordinal
Either "primary" or "secondary", to determine if the server has primary
operation or failover operation on the bridge.
.SS Data format - version 1
The version 1 format is the same as version 2, but with the "product" field
removed.
.P
Valid values for
.I env
are 'dev', 'load', 'prod', 'stag', 'test'.  These can be overridden with
an entry 'default.env' in the ini config file.
.P
Valid values for
.I active
are 'yes', 'no', 'win'.  Where 'win' indicates a Windows box with no SSH
access.
.P
Valid values for
.I apptools
are 'yes', 'no', 'manual'.  Where 'manual' means that Apptools cannot be
update manually.
.P
Valid values for
.I ordinal
are 'primary' and 'secondary'.
.P
The values for
.IR host ,
.I user
and
.I net
can be any relevant string.
.P
.SH AUTHOR
Michael P. Reilly <arcege@gmail.com>
.SH "SEE ALSO"
.BR svrfilter (1)
